<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>EDS API: eds::arch Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">EDS API
   </div>
   <div id="projectbrief">Enterprise Data Server Application Programming Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('namespaceeds_1_1arch.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">eds::arch Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Namespace for all archive client related classes.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeds_1_1arch_1_1_arch_client.html">ArchClient</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Archive data client.  <a href="classeds_1_1arch_1_1_arch_client.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeds_1_1arch_1_1_report_function.html">ReportFunction</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a report function with its parameters.  <a href="classeds_1_1arch_1_1_report_function.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structeds_1_1arch_1_1_point_value.html">PointValue</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Point value (sample)  <a href="structeds_1_1arch_1_1_point_value.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeds_1_1arch_1_1_tabular_trend.html">TabularTrend</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a tabular trend with its parameters.  <a href="classeds_1_1arch_1_1_tabular_trend.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classeds_1_1arch_1_1_arch_client_error.html">ArchClientError</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Thrown when backend library returns an error.  <a href="classeds_1_1arch_1_1_arch_client_error.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:adb7d936aef93f979ef55a002c2911636"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb7d936aef93f979ef55a002c2911636"></a>
typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceeds_1_1arch.html#adb7d936aef93f979ef55a002c2911636">QueryId</a></td></tr>
<tr class="memdesc:adb7d936aef93f979ef55a002c2911636"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier of report query. <br/></td></tr>
<tr class="memitem:a1401dd12e8bc228f41b1688b4395d55b"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; <a class="el" href="structeds_1_1arch_1_1_point_value.html">PointValue</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceeds_1_1arch.html#a1401dd12e8bc228f41b1688b4395d55b">TabularTrendRow</a></td></tr>
<tr class="memdesc:a1401dd12e8bc228f41b1688b4395d55b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Row of tabular trend result data.  <a href="#a1401dd12e8bc228f41b1688b4395d55b"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a32e2fe0d83ab8f76bae8606995802373"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceeds_1_1arch.html#a32e2fe0d83ab8f76bae8606995802373">ShadeMode</a> { <a class="el" href="namespaceeds_1_1arch.html#a32e2fe0d83ab8f76bae8606995802373a7dfe4c28bb1e82c47a370c8ea6c976ca">ShadeMode_PreferRegular</a> =  0x00, 
<a class="el" href="namespaceeds_1_1arch.html#a32e2fe0d83ab8f76bae8606995802373a4703a549f726f1c3d78937b20d4dce17">ShadeMode_PreferShade</a> =  0x01, 
<a class="el" href="namespaceeds_1_1arch.html#a32e2fe0d83ab8f76bae8606995802373a495360b87c6ee4d1b0bb43aaa7d7926b">ShadeMode_OnlyRegular</a> =  0x02, 
<a class="el" href="namespaceeds_1_1arch.html#a32e2fe0d83ab8f76bae8606995802373afcdac9243bbc2eae05c8e33e7c95409d">ShadeMode_OnlyShade</a> =  0x03
 }</td></tr>
<tr class="memdesc:a32e2fe0d83ab8f76bae8606995802373"><td class="mdescLeft">&#160;</td><td class="mdescRight">Archive / shade download preference.  <a href="namespaceeds_1_1arch.html#a32e2fe0d83ab8f76bae8606995802373">More...</a><br/></td></tr>
<tr class="memitem:ac70662921f57ae50e4723004d87dbac6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6">ArchErrorCode</a> { <br/>
&#160;&#160;<a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6aa6c295f50fce02ac1884e9a0f52c45b3">ArchErrorCode_NoError</a> =  0, 
<a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6a73e1bf15d4733ff690bd8bcfad452374">ArchErrorCode_InvalidResult</a> =  -20, 
<a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6a9bcb8bebe50e1522554f2e5a29681796">ArchErrorCode_BadConnectionObject</a> =  -200, 
<a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6a87534402977ab497355452496a86dbce">ArchErrorCode_NoSuchFunction</a> =  -201, 
<br/>
&#160;&#160;<a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6aafe3833d5f1b90048da658c31d4ed659">ArchErrorCode_ShadeWriteFailed</a> =  -202, 
<a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6a263d816a32bf247485a349398578e373">ArchErrorCode_NoConnection</a> =  -203, 
<a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6aa1cafcc2a7fc53502438c8fc088edf32">ArchErrorCode_BadParams</a> =  -204, 
<a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6ad359c1bc48bbcdafe3f1c6bbb5a58d41">ArchErrorCode_ProtocolMismatch</a> =  -205
<br/>
 }</td></tr>
<tr class="memdesc:ac70662921f57ae50e4723004d87dbac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">ArchClient's error codes.  <a href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6">More...</a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Namespace for all archive client related classes. </p>
</div><h2>Typedef Documentation</h2>
<a class="anchor" id="a1401dd12e8bc228f41b1688b4395d55b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::vector&lt;<a class="el" href="structeds_1_1arch_1_1_point_value.html">PointValue</a>&gt; <a class="el" href="namespaceeds_1_1arch.html#a1401dd12e8bc228f41b1688b4395d55b">eds::arch::TabularTrendRow</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Row of tabular trend result data. </p>
<p>Each element of this vector represents a single value of a point in trend (vector values correspond to trend columns). </p>

</div>
</div>
<h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a32e2fe0d83ab8f76bae8606995802373"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="namespaceeds_1_1arch.html#a32e2fe0d83ab8f76bae8606995802373">eds::arch::ShadeMode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Archive / shade download preference. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a32e2fe0d83ab8f76bae8606995802373a7dfe4c28bb1e82c47a370c8ea6c976ca"></a>ShadeMode_PreferRegular</em>&nbsp;</td><td>
<p>Prefer archive values over shades. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a32e2fe0d83ab8f76bae8606995802373a4703a549f726f1c3d78937b20d4dce17"></a>ShadeMode_PreferShade</em>&nbsp;</td><td>
<p>Prefer shades over archive values. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a32e2fe0d83ab8f76bae8606995802373a495360b87c6ee4d1b0bb43aaa7d7926b"></a>ShadeMode_OnlyRegular</em>&nbsp;</td><td>
<p>Use only archive values. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a32e2fe0d83ab8f76bae8606995802373afcdac9243bbc2eae05c8e33e7c95409d"></a>ShadeMode_OnlyShade</em>&nbsp;</td><td>
<p>Use only shades. </p>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a class="anchor" id="ac70662921f57ae50e4723004d87dbac6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="namespaceeds_1_1arch.html#ac70662921f57ae50e4723004d87dbac6">eds::arch::ArchErrorCode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><a class="el" href="classeds_1_1arch_1_1_arch_client.html" title="Archive data client.">ArchClient</a>'s error codes. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ac70662921f57ae50e4723004d87dbac6aa6c295f50fce02ac1884e9a0f52c45b3"></a>ArchErrorCode_NoError</em>&nbsp;</td><td>
<p>No error occured. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac70662921f57ae50e4723004d87dbac6a73e1bf15d4733ff690bd8bcfad452374"></a>ArchErrorCode_InvalidResult</em>&nbsp;</td><td>
<p>Backend function returned invalid result. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac70662921f57ae50e4723004d87dbac6a9bcb8bebe50e1522554f2e5a29681796"></a>ArchErrorCode_BadConnectionObject</em>&nbsp;</td><td>
<p>Invalid connection object. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac70662921f57ae50e4723004d87dbac6a87534402977ab497355452496a86dbce"></a>ArchErrorCode_NoSuchFunction</em>&nbsp;</td><td>
<p>Invalid report function. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac70662921f57ae50e4723004d87dbac6aafe3833d5f1b90048da658c31d4ed659"></a>ArchErrorCode_ShadeWriteFailed</em>&nbsp;</td><td>
<p>Failed to write shade. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac70662921f57ae50e4723004d87dbac6a263d816a32bf247485a349398578e373"></a>ArchErrorCode_NoConnection</em>&nbsp;</td><td>
<p>No connection to server. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac70662921f57ae50e4723004d87dbac6aa1cafcc2a7fc53502438c8fc088edf32"></a>ArchErrorCode_BadParams</em>&nbsp;</td><td>
<p>Invalid report function arguments. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ac70662921f57ae50e4723004d87dbac6ad359c1bc48bbcdafe3f1c6bbb5a58d41"></a>ArchErrorCode_ProtocolMismatch</em>&nbsp;</td><td>
<p>Client-server protocol mismatch. </p>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceeds.html">eds</a></li><li class="navelem"><a class="el" href="namespaceeds_1_1arch.html">arch</a></li>
    <li class="footer">Generated on Tue Jul 31 2012 17:22:09 for EDS API by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
  </ul>
</div>
</body>
</html>
